回顧Day 16所提到的 Scrum 看板有別於 Kanban 的特性,
因此對應的技術文件必須可追蹤
,才能因應動態調整的開發過程。
最快的方式就是撒錢購買confluence或者allanswered。這樣公司內就能有一個私有的開發知識庫
。介面差不多就是類iT邦幫忙網頁
+版控追蹤
的整合體。真心的推薦這兩套工具。
不過,在這裡我們並不需要為了「喝牛奶而養一頭牛」,多一個網站功能要維護,對於運維都是一項負擔。
至於如何達成可追蹤的技術文件控管這個問題 :
只要導入Git版控,就能輕鬆解決可追蹤的這個問題
。
Git私人倉庫的建構,這邊不介紹。線上的Bitbucket與Github也是可以考慮 private 的方案。
至於Git的管理工具私心推薦Sourcetree,操作方式也不介紹。
有興趣的可以自行在iT邦幫忙
檢索下。
至於文件製作的方式,只要是具備多人協同編輯功能的軟體皆可,例如: Microsoft365 中的 Word。
不過由於本身從事軟體開發,還是喜歡用Markdown
功能的工具來編輯文件。
不清楚Markdown
的話請參考這裡。
以程式碼的文件效果來說,
這是 Word :
這是 Markdown :
直接高下立判了。
初學者想學Markdown製作文件,非常建議直接從HackMD來入門。由於已附上教學的連結,這裡也不特別講解了。其實,直接從iT邦幫忙
入門也是可以的。
接下來幾天,會透過程式開發階段的文件
、導入第三方技術的技術文件
、操作手冊技術文件
、運營排查文件
範例,分享個人的文件撰寫經驗談。